Nuke: Build workfile by template #3544

friquette · 2022-07-20T16:12:33Z

Brief description

Following discussion https://github.com/pypeclub/OpenPype/discussions/2013
This PR depends on the Maya build workfile by template #3315

Templated Build Workfile

Building a workfile using a template designed by users. Helping to assert homogeneous subsets hierarchy and imports. Template stored as file easy to define, change and customize for production needs.

1. Make a template

Make your template. Add nodes and everything needed for your tasks. Here is an example template for the compositing task using a placeholder.

The placeholder will be replaced by the nodes you want. To create a placeholder: OpenPype > Template Builder > Create Place Holder

Configure placeholders

Fill in the necessary fields (the optional fields are regex filters)

- Builder type: Wether the the placeholder should load current asset representations or linked assets representations

- Representation: Representation that will be loaded (ex: ma, abc, png, etc...)

- Family: Family of the representation to load (main, look, image, etc ...)

- Loader: Placeholder loader name that will be used to load corresponding representations

- Order: Priority for current placeholder loader (priority is lowest first, highet last)

Save your template

2. Configure Template

Go to Studio settings > Project > Your DCC > Templated Build Settings
Add a profile for your task and enter path to your template

3. Build your workfile

Open Nuke
Build your workfile

mkolar · 2022-07-22T12:17:18Z

Thank you @friquette! we're actually just about to approve and merge the source PR for Maya, which opens the road this right away. We'll have a look and give it a proper review

jrsndl · 2022-07-22T15:29:46Z

Thank you @friquette , this is awesome! I was able to make and use template with loadClip for mov and exr.

Is there a way to load "look" as input process with LoadEffectsInputProcess? I was not able to make it work.
A minor one - looks like the template can't handle connecting loadClip with retime (Timewarp node).
The Path to template in settings is accepting root, but it refused {project[name]} or {task[name]}, it would be great to have that flexibility.
Applying template adds rogue Y_init knob in the OpenPype tab of the create Read.

m-u-r-p-h-y

There is an error during Nuke startup

  sys.version_info < (3,) and warnings.warn("*" * 60 + msg + "*" * 60)
Traceback (most recent call last):
  File "D:\REPO\OpenPype\openpype\hosts\nuke\startup/menu.py", line 5, in <module>
    from openpype.hosts.nuke import api
  File "D:\REPO\OpenPype\openpype\hosts\nuke\api\__init__.py", line 17, in <module>
    from .plugin import OpenPypeCreator
  File "D:\REPO\OpenPype\openpype\hosts\nuke\api\plugin.py", line 14, in <module>
    from .lib import (
  File "D:\REPO\OpenPype\openpype\hosts\nuke\api\lib.py", line 24, in <module>
    from openpype.tools.utils import host_tools
  File "D:\REPO\OpenPype\openpype\tools\utils\__init__.py", line 1, in <module>
    from .widgets import (
  File "D:\REPO\OpenPype\openpype\tools\utils\widgets.py", line 4, in <module>
    from openpype.vendor.python.common import qargparse
ImportError: No module named python.common

openpype/hosts/nuke/plugins/load/load_image.py

openpype/tools/utils/widgets.py

…io.com/quad/openpype/OpenPype into build-workfile-template-nuke

m-u-r-p-h-y

still no luck for me . . .

 sys.version_info < (3,) and warnings.warn("*" * 60 + msg + "*" * 60)
Traceback (most recent call last):
  File "D:\REPO\OpenPype\openpype\hosts\nuke\startup/menu.py", line 3, in <module>
    from openpype.api import Logger
  File "D:\REPO\OpenPype\openpype\api.py", line 1, in <module>
    from .settings import (
  File "D:\REPO\OpenPype\openpype\settings\__init__.py", line 27, in <module>
    from .entities import (
  File "D:\REPO\OpenPype\openpype\settings\entities\__init__.py", line 73, in <module>
    from .base_entity import (
  File "D:\REPO\OpenPype\openpype\settings\entities\base_entity.py", line 18, in <module>
    from openpype.lib import PypeLogger
  File "D:\REPO\OpenPype\openpype\lib\__init__.py", line 54, in <module>
    from .execute import (
  File "D:\REPO\OpenPype\openpype\lib\execute.py", line 8, in <module>
    from .log import PypeLogger as Logger
  File "D:\REPO\OpenPype\openpype\lib\log.py", line 28, in <module>
    from .mongo import (
  File "D:\REPO\OpenPype\openpype\lib\mongo.py", line 5, in <module>
    import pymongo
  File "D:\REPO\OpenPype\.venv\lib\site-packages\pymongo\__init__.py", line 112, in <module>
    from pymongo.collection import ReturnDocument
  File "D:\REPO\OpenPype\.venv\lib\site-packages\pymongo\collection.py", line 29, in <module>
    from pymongo import (common,
  File "D:\REPO\OpenPype\.venv\lib\site-packages\pymongo\common.py", line 36, in <module>
    from pymongo.ssl_support import (validate_cert_reqs,
  File "D:\REPO\OpenPype\.venv\lib\site-packages\pymongo\ssl_support.py", line 36, in <module>
    import certifi
  File "D:\REPO\OpenPype\.venv\lib\site-packages\certifi\__init__.py", line 1, in <module>
    from .core import contents, where
  File "D:\REPO\OpenPype\.venv\lib\site-packages\certifi\core.py", line 17
    def where() -> str:
                ^
SyntaxError: invalid syntax

friquette · 2022-08-03T14:04:33Z

Are you sure your venv is set in python3 ?

m-u-r-p-h-y · 2022-08-03T14:23:38Z

think so, . .

jakubjezek001 · 2022-08-17T12:12:21Z

openpype/hosts/nuke/api/lib_template_builder.py

@@ -0,0 +1,206 @@
+from collections import OrderedDict
+
+from openpype.vendor.python.common import qargparse


Suggested change

from openpype.vendor.python.common import qargparse

import qargparse

jakubjezek001 · 2022-08-17T12:13:30Z

openpype/hosts/nuke/api/lib_template_builder.py

+
+from openpype.vendor.python.common import qargparse
+from openpype.tools.utils.widgets import OptionDialog
+from openpype.hosts.nuke.api.lib import imprint


Suggested change

from openpype.hosts.nuke.api.lib import imprint

from .lib import imprint

jakubjezek001 · 2022-08-17T12:35:16Z

openpype/hosts/nuke/api/template_loader.py

+ def populate_template(self, ignored_ids=None):
+ place_holders = self.get_template_nodes()
+ while len(place_holders) > 0:
+ super().populate_template(ignored_ids)


Suggested change

super().populate_template(ignored_ids)

super(NukeTemplateLoader, self).populate_template(ignored_ids)

jakubjezek001 · 2022-08-17T12:35:44Z

openpype/hosts/nuke/api/template_loader.py

+ return ids
+
+ def get_placeholders(self):
+ placeholders = super().get_placeholders()


Suggested change

placeholders = super().get_placeholders()

placeholders = super(NukeTemplateLoader, self).get_placeholders()

jakubjezek001 · 2022-08-17T12:37:30Z

openpype/hosts/nuke/api/template_loader.py

+ set inputs and outputs of loaded nodes"""
+
+ node = self.data['node']
+ input, output = get_io(self.data['last_loaded'])


There might be also some single unconnected nodes

Traceback (most recent call last): File "C:\CODE\__PYPE\OpenPype\openpype\hosts\nuke\api\pipeline.py", line 223, in <lambda> lambda: build_workfile_template() File "C:\CODE\__PYPE\OpenPype\openpype\lib\build_template.py", line 28, in build_workfile_template template_loader.populate_template() File "C:\CODE\__PYPE\OpenPype\openpype\hosts\nuke\api\template_loader.py", line 47, in populate_template super(NukeTemplateLoader, self).populate_template(ignored_ids) File "C:\CODE\__PYPE\OpenPype\openpype\lib\abstract_template_loader.py", line 254, in populate_template self.postload(placeholder) File "C:\CODE\__PYPE\OpenPype\openpype\lib\abstract_template_loader.py", line 306, in postload placeholder.clean() File "C:\CODE\__PYPE\OpenPype\openpype\hosts\nuke\api\template_loader.py", line 447, in clean self.set_loaded_connections() File "C:\CODE\__PYPE\OpenPype\openpype\hosts\nuke\api\template_loader.py", line 346, in set_loaded_connections input, output = get_io(self.data['last_loaded']) File "C:\CODE\__PYPE\OpenPype\openpype\hosts\nuke\api\lib.py", line 2628, in get_io raise Exception("No Input found") Exception: No Input found

but it might be perhaps different issue. I had connected the placeholder node to a dot and it still is having the same Traceback..

jakubjezek001 · 2022-09-23T12:08:05Z

Closing as it is replaced by #3838

anas.fadil and others added 11 commits June 27, 2022 12:52

first implementation

1278a3f

clean divided

f2b0e0c

clean divided into multiple commented methods

87be0db

clean divided into multiple commented methods

9b6a231

doc

4fcad75

doc

2b4cd2a

fix linting errors

5b0fdd8

useless comments removed

703f660

useless comments removed

a06f755

update doc

74135fa

empty problem solved

5c57626

friquette marked this pull request as ready for review July 20, 2022 16:15

fix linting

3529611

mkolar requested review from jrsndl and m-u-r-p-h-y July 22, 2022 12:14

jrsndl approved these changes Jul 26, 2022

View reviewed changes

m-u-r-p-h-y suggested changes Jul 28, 2022

View reviewed changes

iLLiCiTiT reviewed Jul 28, 2022

View reviewed changes

openpype/hosts/nuke/plugins/load/load_image.py Outdated Show resolved Hide resolved

iLLiCiTiT reviewed Jul 28, 2022

View reviewed changes

openpype/tools/utils/widgets.py Outdated Show resolved Hide resolved

anas.fadil added 3 commits July 28, 2022 11:55

import qargparse fixed

c730b07

Merge branch 'build-workfile-template-nuke' of https://gitlab.fixstud…

43c55e9

…io.com/quad/openpype/OpenPype into build-workfile-template-nuke

import qargparse fixed

a2ad8c3

friquette requested a review from m-u-r-p-h-y August 3, 2022 08:29

m-u-r-p-h-y suggested changes Aug 3, 2022

View reviewed changes

jrsndl mentioned this pull request Aug 16, 2022

Nuke: Build template from workfile #3681

Closed

jakubjezek001 self-requested a review August 17, 2022 11:57

jakubjezek001 reviewed Aug 17, 2022

View reviewed changes

jakubjezek001 suggested changes Aug 17, 2022

View reviewed changes

iLLiCiTiT mentioned this pull request Aug 24, 2022

Workfile template build enhancements #3726

Closed

iLLiCiTiT added a commit that referenced this pull request Aug 31, 2022

added build documentation from #3544

400ff1d

iLLiCiTiT mentioned this pull request Aug 31, 2022

Nuke: Build workfile by template #3763

Merged

jakubjezek001 closed this Sep 23, 2022

ClementHector mentioned this pull request Apr 13, 2023

Maya template builder - preserve all references when importing a template #4797

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Nuke: Build workfile by template #3544

Nuke: Build workfile by template #3544

friquette commented Jul 20, 2022 •

edited

Loading

mkolar commented Jul 22, 2022

jrsndl commented Jul 22, 2022 •

edited

Loading

m-u-r-p-h-y left a comment

m-u-r-p-h-y left a comment

friquette commented Aug 3, 2022

m-u-r-p-h-y commented Aug 3, 2022

jakubjezek001 Aug 17, 2022

jakubjezek001 Aug 17, 2022

jakubjezek001 Aug 17, 2022

jakubjezek001 Aug 17, 2022

jakubjezek001 Aug 17, 2022

jakubjezek001 Aug 17, 2022

jakubjezek001 commented Sep 23, 2022

		@@ -0,0 +1,206 @@
		from collections import OrderedDict

		from openpype.vendor.python.common import qargparse

	from openpype.vendor.python.common import qargparse
	import qargparse

	from openpype.hosts.nuke.api.lib import imprint
	from .lib import imprint

	super().populate_template(ignored_ids)
	super(NukeTemplateLoader, self).populate_template(ignored_ids)

	placeholders = super().get_placeholders()
	placeholders = super(NukeTemplateLoader, self).get_placeholders()

Nuke: Build workfile by template #3544

Nuke: Build workfile by template #3544

Conversation

friquette commented Jul 20, 2022 • edited Loading

Brief description

Templated Build Workfile

mkolar commented Jul 22, 2022

jrsndl commented Jul 22, 2022 • edited Loading

m-u-r-p-h-y left a comment

Choose a reason for hiding this comment

m-u-r-p-h-y left a comment

Choose a reason for hiding this comment

friquette commented Aug 3, 2022

m-u-r-p-h-y commented Aug 3, 2022

jakubjezek001 Aug 17, 2022

Choose a reason for hiding this comment

jakubjezek001 Aug 17, 2022

Choose a reason for hiding this comment

jakubjezek001 Aug 17, 2022

Choose a reason for hiding this comment

jakubjezek001 Aug 17, 2022

Choose a reason for hiding this comment

jakubjezek001 Aug 17, 2022

Choose a reason for hiding this comment

jakubjezek001 Aug 17, 2022

Choose a reason for hiding this comment

jakubjezek001 commented Sep 23, 2022

friquette commented Jul 20, 2022 •

edited

Loading

jrsndl commented Jul 22, 2022 •

edited

Loading